Skip to main content

dropboxListFolderGetLatestCursor

Type

command

Summary

A way to get a cursor for the folder's state.

Syntax

dropboxListFolderGetLatestCursor <pAccessToken>, <pPath>, <pRecursive>, <pIncludeMediaInfo>, [<pCallback>]

Description

Unlike dropboxListFolder, dropboxListFolderGetLatestCursor doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox. Use the returned cursor with dropboxListFolderContinue to obtain the entries.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pPath

The path to the folder you want to see the contents of.

pRecursive

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is False.

pIncludeMediaInfo

If true, FileMetadata.media_info is set for photo and video. The default for this field is False.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.